CRPEGroupOptions

This structure contains information about several options available with report groups. This information is used by CRPEJob::GetGroupOptions, to retrieve current options and by CRPEJob::SetGroupOptions, to pass new option settings.

Data Members

Each data member is set by the corresponding constructor parameter.

Member Type Default Description

m_condition

short

0

Specifies the condition setting for the selected group section. See Remarks below.

m_fieldName

_TCHAR

'\0'

Specifies the field name of the group field (of size PEP_FIELD_NAME_LEN = 512), or remains empty for no change.

m_sortDirection

short

0
Descending

Specifies the sort direction. Uses one of the PEP_SF_XXX Sort Order Constants or PEP_UNCHANGED for no change. For group conditions only, use PEP_SF_ORIGINAL for original order or PEP_SF_SPECIFIED for read-only specified sort order.

m_repeatGroup
Header

short

0

BOOL value, or PEP_UNCHANGED for no change.

m_keepGroup
Together

short

0

BOOL value, or PEP_UNCHANGED for no change.

m_topOrBottom
NGroups

short

0

Use one of the following PEP_GO_TBN_XXX constants or PEP_UNCHANGED for no change.


Constant Description


PEP_GO_TBN_ALL_
GROUPS_UNSORTED

There is no group sorting or Top/Bottom N for this level of grouping.


PEP_GO_TBN_ALL_
GROUPS_SORTED

There is group sorting, but not Top/Bottom N.


PEP_GO_TBN_TOP_
N_GROUPS

Top N groups will be selected.


PEP_GO_TBN_
BOTTOM_N_GROUPS

Bottom N groups will be selected.

Member Type Default Description

m_topOrBottom
NSortFieldName

_TCHAR

'\0'

Specifies the name of the summary field (of size PEP_FIELD_NAME_LEN = 512) by which the groups are ordered, or remains empty for no change.

m_nTopOr
BottomGroups

short

0
Keep all
groups

Number of groups to select.

m_discardOther
Groups

short

0

Determines whether the remaining groups are collected into an Others group or discarded. BOOL value, or PEP_UNCHANGED for no change.

hierarchical
Sorting

short

FALSE

Boolean. Specifies whether or not to do hierarchial sorting.

*instanceIDField

_TCHAR

'\0'

Specifies a pointer to the name of the instance ID field (of size PEP_FIELD_NAME_LEN = 512) for hierarchial sorting.

*parentIDField

_TCHAR

'\0'

Specifies a pointer to the name of the parent ID field (of size PEP_FIELD_NAME_LEN = 512) for hierarchial sorting.

groupIndent

long

0

Specifies the indent for the group, in twips.

Remarks
Constructor CRPEGroupOptions::CRPEGroupOptions

This constructs a CRPEGroupOptions structure object. Call the constructor with no parameters to allow the Class Library to initialize all member variables with default values. Pass parameters to the constructor to assign specific values to each member variable.

Constructor Syntax (Default)

CRPEGroupOptions ();

Constructor. Syntax
CRPEGroupOptions (
        short condition,
        _TCHAR *fieldName,
        short sortDirection,
        short repeatGroupHeader,
        short keepGroupTogether,
        short topOrBottomNGroups,
        _TCHAR *topOrBottomNSortFieldName,
        short nTopOrBottomGroups,
        short discardOtherGroups,
        short hierarchicalSorting
        _TCHAR instanceIDField
        _TCHAR parentIDField
        long groupIndent );


Seagate Software IMG Holdings, Inc.
http://www.seagatesoftware.com
Support services:
http://support.seagatesoftware.com